<!doctype html>
<html>
<head>
    <title>API for class FILTER (idxCMS: Flat Files Content Management Sysytem ver. 5.0)</title>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <meta name="generator" content="phpAPI 6.0 (https://github.com/Greenray/phpAPI/)">
    <link href="../style.css" type="text/css" rel="stylesheet" />
</head>
<body>
    <div class="page">
        <div class="header center">
            <div class="content">
                idxCMS: Flat Files Content Management Sysytem ver. 5.0                <div class="logo_desc">Application Programming Interface</div>
            </div>
        </div>
        <div class="panel">
            <div class="content">
                <h1>Namespaces</h1>
<ul>
    <li><a href="../administration/package-summary.html">Administration</a></li>
    <li><a href="../catalogs/package-summary.html">Catalogs</a></li>
    <li><a href="../core/package-summary.html">Core</a></li>
    <li><a href="../forum/package-summary.html">Forum</a></li>
    <li><a href="../gallery/package-summary.html">Gallery</a></li>
    <li><a href="../no package/package-summary.html">No Package</a></li>
    <li><a href="../polls/package-summary.html">Polls</a></li>
    <li><a href="../posts/package-summary.html">Posts</a></li>
    <li><a href="../rss/package-summary.html">RSS</a></li>
    <li><a href="../rate/package-summary.html">Rate</a></li>
    <li><a href="../search/package-summary.html">Search</a></li>
    <li><a href="../statistics/package-summary.html">Statistics</a></li>
    <li><a href="../tagcloud/package-summary.html">Tagcloud</a></li>
    <li><a href="../template/package-summary.html">Template</a></li>
    <li><a href="../tools/package-summary.html">Tools</a></li>
    <li><a href="../user/package-summary.html">User</a></li>
</ul>
<h1>Namespace User</h1>
    <h2>Classes</h2>
    <ul>
            <li><a href="../core/categories.html" title="Core \ CATEGORIES">CATEGORIES</a></li>
            <li><a href="../core/cms.html" title="Core \ CMS">CMS</a></li>
            <li><a href="../core/comments.html" title="Core \ COMMENTS">COMMENTS</a></li>
            <li><a href="../core/config.html" title="Core \ CONFIG">CONFIG</a></li>
            <li><a href="../core/content.html" title="Core \ CONTENT">CONTENT</a></li>
            <li><a href="../core/dbase.html" title="Core \ DBASE">DBASE</a></li>
            <li><a href="../core/filter.html" title="Core \ FILTER">FILTER</a></li>
            <li><a href="../core/highlighter.html" title="Core \ HIGHLIGHTER">HIGHLIGHTER</a></li>
            <li><a href="../core/image.html" title="Core \ IMAGE">IMAGE</a></li>
            <li><a href="../core/items.html" title="Core \ ITEMS">ITEMS</a></li>
            <li><a href="../core/log.html" title="Core \ LOG">LOG</a></li>
            <li><a href="../core/parser.html" title="Core \ PARSER">PARSER</a></li>
            <li><a href="../core/sections.html" title="Core \ SECTIONS">SECTIONS</a></li>
            <li><a href="../core/system.html" title="Core \ SYSTEM">SYSTEM</a></li>
            <li><a href="../core/uploader.html" title="Core \ UPLOADER">UPLOADER</a></li>
        </ul>
    <h2>Functions</h2>
    <ul>
            <li><a href="../core/package-functions.html#AdvScanDir" title="Core">AdvScanDir</a></li>
            <li><a href="../core/package-functions.html#AdvancedPagination" title="Core">AdvancedPagination</a></li>
            <li><a href="../core/package-functions.html#CheckCaptcha" title="Core">CheckCaptcha</a></li>
            <li><a href="../core/package-functions.html#CreateUrl" title="Core">CreateUrl</a></li>
            <li><a href="../core/package-functions.html#DeleteTree" title="Core">DeleteTree</a></li>
            <li><a href="../core/package-functions.html#FormatTime" title="Core">FormatTime</a></li>
            <li><a href="../core/package-functions.html#GetFilesList" title="Core">GetFilesList</a></li>
            <li><a href="../core/package-functions.html#GetPagination" title="Core">GetPagination</a></li>
            <li><a href="../core/package-functions.html#OnlyLatin" title="Core">OnlyLatin</a></li>
            <li><a href="../core/package-functions.html#Pagination" title="Core">Pagination</a></li>
            <li><a href="../core/package-functions.html#RandomString" title="Core">RandomString</a></li>
            <li><a href="../core/package-functions.html#Redirect" title="Core">Redirect</a></li>
            <li><a href="../core/package-functions.html#SelectTimeZone" title="Core">SelectTimeZone</a></li>
            <li><a href="../core/package-functions.html#SendMail" title="Core">SendMail</a></li>
            <li><a href="../core/package-functions.html#ShowCaptcha" title="Core">ShowCaptcha</a></li>
            <li><a href="../core/package-functions.html#Sitemap" title="Core">Sitemap</a></li>
            <li><a href="../core/package-functions.html#UnifyBr" title="Core">UnifyBr</a></li>
            <li><a href="../core/package-functions.html#" title="Core"></a></li>
            <li><a href="../core/package-functions.html#gzfile_get_contents" title="Core">gzfile_get_contents</a></li>
            <li><a href="../core/package-functions.html#gzfile_put_contents" title="Core">gzfile_put_contents</a></li>
            <li><a href="../core/package-functions.html#idxErrorHandler" title="Core">idxErrorHandler</a></li>
        </ul>
    <h2>Globals</h2>
    <ul>
            <li><a href="../core/package-globals.html#ADMIN" title="Core">ADMIN</a></li>
            <li><a href="../core/package-globals.html#ADMINLIBS" title="Core">ADMINLIBS</a></li>
            <li><a href="../core/package-globals.html#CACHE" title="Core">CACHE</a></li>
            <li><a href="../core/package-globals.html#CATEGORY" title="Core">CATEGORY</a></li>
            <li><a href="../core/package-globals.html#COMMENT" title="Core">COMMENT</a></li>
            <li><a href="../core/package-globals.html#CONTENT" title="Core">CONTENT</a></li>
            <li><a href="../core/package-globals.html#CURRENT_MODULE" title="Core">CURRENT_MODULE</a></li>
            <li><a href="../core/package-globals.html#CURRENT_SKIN" title="Core">CURRENT_SKIN</a></li>
            <li><a href="../core/package-globals.html#DS" title="Core">DS</a></li>
            <li><a href="../core/package-globals.html#IDX_COPYRIGHT" title="Core">IDX_COPYRIGHT</a></li>
            <li><a href="../core/package-globals.html#IDX_POWERED" title="Core">IDX_POWERED</a></li>
            <li><a href="../core/package-globals.html#IDX_VERSION" title="Core">IDX_VERSION</a></li>
            <li><a href="../core/package-globals.html#IMAGES" title="Core">IMAGES</a></li>
            <li><a href="../core/package-globals.html#ITEM" title="Core">ITEM</a></li>
            <li><a href="../core/package-globals.html#LF" title="Core">LF</a></li>
            <li><a href="../core/package-globals.html#LOGS" title="Core">LOGS</a></li>
            <li><a href="../core/package-globals.html#MODULE" title="Core">MODULE</a></li>
            <li><a href="../core/package-globals.html#MODULES" title="Core">MODULES</a></li>
            <li><a href="../core/package-globals.html#PAGE" title="Core">PAGE</a></li>
            <li><a href="../core/package-globals.html#ROOT" title="Core">ROOT</a></li>
            <li><a href="../core/package-globals.html#SECTION" title="Core">SECTION</a></li>
            <li><a href="../core/package-globals.html#SKINS" title="Core">SKINS</a></li>
            <li><a href="../core/package-globals.html#SMILES" title="Core">SMILES</a></li>
            <li><a href="../core/package-globals.html#SYS" title="Core">SYS</a></li>
            <li><a href="../core/package-globals.html#TEMP" title="Core">TEMP</a></li>
            <li><a href="../core/package-globals.html#TEMPLATES" title="Core">TEMPLATES</a></li>
            <li><a href="../core/package-globals.html#TOOLS" title="Core">TOOLS</a></li>
            <li><a href="../core/package-globals.html#USERS" title="Core">USERS</a></li>
            <li><a href="../core/package-globals.html#idxADMIN" title="Core">idxADMIN</a></li>
            <li><a href="../core/package-globals.html#idxCMS" title="Core">idxCMS</a></li>
        </ul>
            </div>
        </div>
        <div class="main">
            <div class="content">
                <nav class="menu_main center"><div class="menu">
            <ul>
                    <li><a href="../index.html">Overview</a></li>
                    <li><a href="../core/package-summary.html">Namespace</a></li>
                    <li class="active">Class</li>
                    <li><a href="../core/package-tree.html">Core\Tree</a></li>
                    <li><a href="../deprecated.html">Deprecated</a></li>
                    <li><a href="../todo.html">Todo</a></li>
                    <li><a href="../index-all.html">Index</a></li>
                </ul>
    </div>
    <div class="small_links">
        <a href="#details_fields">Fields</a> | <a href="#details_methods">Methods</a> | <a href="#details_constructor">Constructor</a>
    </div>
</nav>
                <hr />
<div class="package">Namespace Core</div>
<h1>Class FILTER</h1>
<div id="list">
    <ul>
        <li><strong>FILTER</strong></li></ul></li>    </ul>
</div>
<hr />
<p class="arguments">public final  class <strong>FILTER</strong></p>
<div class="comment" id="overview_description">Cleans parameters $_REQUEST, $_FILES, $_COOKIE, detect intrusions and ban unwanted visitors.</div>
<div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Program</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">idxCMS: Flat Files Content Management System</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Version</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">5.0</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Author</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">Victor Nabatov &lt;greenray.spb@gmail.com&gt;</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Copyright</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">(c) 2011-2016 Victor Nabatov</td>
                    </tr>
            <tr>
            <td class="hid left w_100">License</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">Creative Commons Attribution-ShareAlike 4.0 International</td>
                    </tr>
            <tr>
            <td class="hid left w_100">File</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">system/filter.class.php</td>
                    </tr>
        </table>
</div>
    <h2 id="details_fields">Fields</h2>
            <div class="location">system/filter.class.php at line 20</div>
        <pre class="arguments" id="COOKIE">private static  array <strong><span class="green">$COOKIE</span></strong> = []</pre>
        <div class="details">Array of filtered $_COOKIE parameters</div>
        <hr />
            <div class="location">system/filter.class.php at line 17</div>
        <pre class="arguments" id="REQUEST">public static  array <strong><span class="green">$REQUEST</span></strong> = []</pre>
        <div class="details">Array of filtered $_POST, $_GET and $_FILES parameters</div>
        <hr />
            <div class="location">system/filter.class.php at line 23</div>
        <pre class="arguments" id="types">private static  array <strong><span class="green">$types</span></strong> = [<span class="red">"REQUEST"</span>, <span class="red">"FILES"</span>, <span class="red">"COOKIE"</span>]</pre>
        <div class="details">Array of parameters types</div>
        <hr />
        <h2 id="details_constructor">Constructor</h2>
    <div class="location">system/filter.class.php at line 26</div>
    <code class="arguments" id="construct">public  void <strong>construct</strong>()</code>
    <div class="details">
            <p class="description">Class initialization</p>
            </div>
    <h2 id="details_methods">Methods</h2>
            <div class="location">system/filter.class.php at line 29</div>
        <code class="arguments" id="clone">public  void <strong>clone</strong> ()</code>
        <div class="details">
                    <p class="description">Prevent to clone object</p>
                    </div>
        <hr />
            <div class="location">system/filter.class.php at line 37</div>
        <code class="arguments" id="cleanValue">private  string <strong>cleanValue</strong> (<span class="lilac">array</span> <span class="blue">$value</span>)</code>
        <div class="details">
                    <p class="description">Cleans all parameters and their values of the request array.</p>
            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">array</td>
                            <td class="hid blue w_100">$value</td>
                <td class="hid">Input array of parameters</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid" colspan="2">Filered parameters</td>
                    </tr>
        </table>
</div>
        </div>
        <hr />
            <div class="location">system/filter.class.php at line 56</div>
        <code class="arguments" id="clear">private  array <strong>clear</strong> (<span class="lilac">array</span> <span class="blue">$vars</span>)</code>
        <div class="details">
                    <p class="description">Cleans variables.</p>
            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">array</td>
                            <td class="hid blue w_100">$vars</td>
                <td class="hid">Input array of parameters</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">array</td>
                            <td class="hid" colspan="2">Filtered values of parameters</td>
                    </tr>
        </table>
</div>
        </div>
        <hr />
            <div class="location">system/filter.class.php at line 77</div>
        <code class="arguments" id="sanitate">public  void <strong>sanitate</strong> ()</code>
        <div class="details">
                    <p class="description">Detects intrusion, clean and unset $_POST, $_GET, $_FILES and $_COOKIE.<br /> The result are two variables: $REQUEST and $COOKIE.</p>
                    </div>
        <hr />
            <div class="location">system/filter.class.php at line 95</div>
        <code class="arguments" id="getAll">public static  array <strong>getAll</strong> (<span class="lilac">string</span> <span class="blue">$type</span>)</code>
        <div class="details">
                    <p class="description">Gets all filtered parameter of the specified type.</p>
            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$type</td>
                <td class="hid">Type of parameter</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">array</td>
                            <td class="hid" colspan="2">Array of filtered parameters of the specified type</td>
                    </tr>
        </table>
</div>
        </div>
        <hr />
            <div class="location">system/filter.class.php at line 106</div>
        <code class="arguments" id="get">public static  array|boolean <strong>get</strong> (<span class="lilac">string</span> <span class="blue">$type</span>, <span class="lilac">string</span> <span class="blue">$param</span>)</code>
        <div class="details">
                    <p class="description">Gets specified filtered parameter.</p>
            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$type</td>
                <td class="hid">Type of parameter</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$param</td>
                <td class="hid">Name of parameter</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">array|boolean</td>
                            <td class="hid" colspan="2">Parameter values or FALSE</td>
                    </tr>
        </table>
</div>
        </div>
        <hr />
            <div class="location">system/filter.class.php at line 120</div>
        <code class="arguments" id="remove">public static  void <strong>remove</strong> (<span class="lilac">string</span> <span class="blue">$type</span>, <span class="lilac">string</span> <span class="blue">$param</span>)</code>
        <div class="details">
                    <p class="description">Removes filtered parameter.</p>
            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$type</td>
                <td class="hid">Type of parameter</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$param</td>
                <td class="hid">Name of parameter</td>
                    </tr>
        </table>
</div>
        </div>
        <hr />
            <div class="location">system/filter.class.php at line 132</div>
        <code class="arguments" id="validEmail">public  boolean <strong>validEmail</strong> (<span class="lilac">string</span> <span class="blue">$email</span>)</code>
        <div class="details">
                    <p class="description">Email validation.</p>
            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$email</td>
                <td class="hid">Email address</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">boolean</td>
                            <td class="hid" colspan="2">The result of operation</td>
                    </tr>
        </table>
</div>
        </div>
        <hr />
            <div class="location">system/filter.class.php at line 141</div>
        <code class="arguments" id="ban">public  boolean <strong>ban</strong> ()</code>
        <div class="details">
                    <p class="description">Bans user.</p>
            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">boolean</td>
                            <td class="hid" colspan="2">The result of operation</td>
                    </tr>
        </table>
</div>
        </div>
        <hr />
            <div class="location">system/filter.class.php at line 156</div>
        <code class="arguments" id="ids">private  void <strong>ids</strong> ()</code>
        <div class="details">
                    <p class="description">Intrusion detection.<br /> In current it can detect:<ul><li>bad words in $_SERVER;</li><li>malicious URL requests;</li><li>banned IP or cookie.</li></ul>If the intrusion will be detected this event will be logged and the system will die.</p>
                    </div>
        <hr />
                    <nav class="menu_main center"><div class="menu">
            <ul>
                    <li><a href="../index.html">Overview</a></li>
                    <li><a href="../core/package-summary.html">Namespace</a></li>
                    <li class="active">Class</li>
                    <li><a href="../core/package-tree.html">Core\Tree</a></li>
                    <li><a href="../deprecated.html">Deprecated</a></li>
                    <li><a href="../todo.html">Todo</a></li>
                    <li><a href="../index-all.html">Index</a></li>
                </ul>
    </div>
    <div class="small_links">
        <a href="#details_fields">Fields</a> | <a href="#details_methods">Methods</a> | <a href="#details_constructor">Constructor</a>
    </div>
</nav>
            </div>
        </div>
    </div>
    <div class="footer">
        <div class="content">
            <div class="copyright center">Generated by <a href="https://github.com/Greenray/phpAPI" target="_blank">phpAPI</a>: PHP Documentation Creator ver. 6.0 &copy; 2015 - 2016 Greenray</div>
        </div>
    </div>
</body>
</html>
